Skip to content

PB-1949 Move tutorials to Tech Docs - #612

Merged
asteiner-swisstopo merged 1 commit into
developfrom
feat-PB-1949-stac-api-specs-link-to-tech-docs
Nov 5, 2025
Merged

PB-1949 Move tutorials to Tech Docs#612
asteiner-swisstopo merged 1 commit into
developfrom
feat-PB-1949-stac-api-specs-link-to-tech-docs

Conversation

@asteiner-swisstopo

Copy link
Copy Markdown
Contributor

This contains two changes to in the apitransactional.html:

  1. Add a link to the Tech Docs on the top of the page.
  2. Remove all content that is now also present in the Tech Docs. Replace it with a short description + a link.

I only pointed to the STAC API Overview page and not to specific subpages, like e.g. Authentication. I thought it does not add a lot of benefit and reduces the risk of outdated links.

Note that the final docs.geo.admin.ch is not live yet but the Terraform code for it is ready and reviewed: https://github.com/geoadmin/infra-terraform-bgdi/pull/1212. So I only merge this when docs.geo.admin.ch is actually online.

To try out how this looks as a website, run this locally:

  1. Run make build-specs
  2. Run make serve-specs
  3. Open the page at http://127.0.0.1:8090/apitransactional.html.

@asteiner-swisstopo asteiner-swisstopo self-assigned this Oct 30, 2025
@github-actions github-actions Bot added the feature New feature or enhancement label Oct 30, 2025

@boecklic boecklic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

@asteiner-swisstopo
asteiner-swisstopo force-pushed the feat-PB-1949-stac-api-specs-link-to-tech-docs branch from 71a79d8 to a12fc03 Compare November 4, 2025 15:42
This  contains two changes to in the [apitransactional.html](https://data.geo.admin.ch/api/stac/static/spec/v1/apitransactional.html):

1. Add a link to the [Tech Docs](https://sys-docs.int.bgdi.ch/download-data/stac-api/overview.html) on the top of the page.
2. Remove all content that is now also present in the [Tech Docs](https://sys-docs.int.bgdi.ch/download-data/stac-api/overview.html). Replace it with a short description + a link.

I only pointed to the [STAC API Overview page](https://sys-docs.int.bgdi.ch/download-data/stac-api/overview.html) and not to specific subpages, like e.g. [Authentication](https://sys-docs.int.bgdi.ch/docs/stac-api/authentication.html). I thought it does not add a lot of benefit and reduces the risk of outdated links.

Note that the final docs.geo.admin.ch is not live yet but the Terraform code for it is ready and reviewed: geoadmin/infra-terraform-bgdi#1212. So I only merge this when docs.geo.admin.ch is actually online.

To try out how this looks as a website, run this locally:
1. Run `make build-specs`
2. Run `make serve-specs`
3. Open the page at http://127.0.0.1:8090/apitransactional.html.
@asteiner-swisstopo
asteiner-swisstopo force-pushed the feat-PB-1949-stac-api-specs-link-to-tech-docs branch from a12fc03 to 6692cd2 Compare November 5, 2025 09:38
@asteiner-swisstopo
asteiner-swisstopo merged commit 0d9b1e3 into develop Nov 5, 2025
3 checks passed
@asteiner-swisstopo
asteiner-swisstopo deleted the feat-PB-1949-stac-api-specs-link-to-tech-docs branch November 5, 2025 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants